* gdk-pixbuf/porting-from-imlib.sgml: GDK instead of Gdk.
* gdk-pixbuf/tmpl/gdk-pixbuf-xlib-init.sgml: Replace references to
deprecated functions.
* gdk/tmpl/event_structs.sgml, gdk/tmpl/gcs.sgml,
gdk/tmpl/images.sgml: Replace references to deprecated functions.
* gdk/tmpl/properties.sgml, gdk/tmpl/selections.sgml: Additions.
* gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
Minor documentation tweaks.
+2001-12-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
+ Minor documentation tweaks.
+
2001-12-28 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS().
+2001-12-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
+ Minor documentation tweaks.
+
2001-12-28 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS().
+2001-12-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
+ Minor documentation tweaks.
+
2001-12-28 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS().
+2001-12-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
+ Minor documentation tweaks.
+
2001-12-28 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS().
+2001-12-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
+ Minor documentation tweaks.
+
2001-12-28 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS().
+2001-12-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
+ Minor documentation tweaks.
+
2001-12-28 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS().
+2001-12-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/x11/gdkproperty-x11.c, gdk/x11/gdkselection-x11.c:
+ Minor documentation tweaks.
+
2001-12-28 Tor Lillqvist <tml@iki.fi>
* gdk/win32/gdkfont-win32.c: Use G_N_ELEMENTS().
+2001-12-28 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk/tmpl/properties.sgml, gdk/tmpl/selections.sgml: Additions.
+
+2001-12-23 Matthias Clasen <matthiasc@poet.de>
+
+ * gdk-pixbuf/porting-from-imlib.sgml: GDK instead of Gdk.
+
+ * gdk-pixbuf/tmpl/gdk-pixbuf-xlib-init.sgml: Replace references to
+ deprecated functions.
+
+ * gdk/tmpl/event_structs.sgml, gdk/tmpl/gcs.sgml,
+ gdk/tmpl/images.sgml: Replace references to deprecated functions.
+
2001-12-28 Vitaly Tishkov <tvv@sparc.spb.su>
+
* gtkwindow.sgml: additional fix for #59314 ('<programlisting>' is
changed to '<literal>' in docs for gtk_window_set_policy ())
<para>
The &gdk-pixbuf; library has the policy of always rendering
- pixbufs to Gdk drawables you provide; it will not create
+ pixbufs to GDK drawables you provide; it will not create
them for you. This is in general more flexible than
&Imlib;'s policy of always creating a pixmap and making you
use that instead.
functions in this section are used to initialize the &gdk-pixbuf;
Xlib library. This library must be initialized near the beginning
of the program or before calling any of the other &gdk-pixbuf;
- Xlib functions; it cannot be initialized automatically since
- Xlib-only applications do not call gdk_rgb_init() like GNOME
- applications do.
+ Xlib functions.
</para>
<!-- ##### SECTION See_Also ##### -->
<!-- ##### STRUCT GdkEventNoExpose ##### -->
<para>
-Generated when the area of a #GdkDrawable being copied, with gdk_draw_pixmap()
+Generated when the area of a #GdkDrawable being copied, with gdk_draw_drawable()
or gdk_window_copy_area(), was completely available.
</para>
<para>
Sets whether copying non-visible portions of a drawable
using this graphics context generate exposure events
for the corresponding regions of the destination
-drawable. (See gdk_draw_pixmap()).
+drawable. (See gdk_draw_drawable()).
</para>
@gc: a #GdkGC.
<para>
To create an empty #GdkImage use gdk_image_new().
To create a #GdkImage from bitmap data use gdk_image_new_bitmap().
-To create an image from part of a #GdkWindow use gdk_image_get().
+To create an image from part of a #GdkWindow use gdk_drawable_get_image().
</para>
<para>
The image can be manipulated with gdk_image_get_pixel() and
A property has an associated <firstterm>format</firstterm>,
an integer describing how many bits are in each unit
of data inside the property. It must be 8, 16, or 32.
-When data is transfered between the server and client,
+When data is transferred between the server and client,
if they are of different endianesses it will be byteswapped
as necessary according to the format of the property.
Note that on the client side, properties of format 32
<!-- ##### STRUCT GdkAtom ##### -->
<para>
-A numeric type representing a string as an index into a table
+An opaque type representing a string as an index into a table
of strings on the X server.
</para>
<!-- ##### MACRO GDK_ATOM_TO_POINTER ##### -->
<para>
-
+Converts a #GdkAtom into a pointer type.
</para>
-@atom:
+@atom: a #GdkAtom.
<!-- ##### MACRO GDK_POINTER_TO_ATOM ##### -->
<para>
-
+Extracts a #GdkAtom from a pointer. The #GdkAtom must have been
+stored in the pointer with GDK_ATOM_TO_POINTER().
</para>
-@ptr:
+@ptr: a pointer containing a #GdkAtom.
<!-- ##### MACRO GDK_NONE ##### -->
<!-- ##### FUNCTION gdk_text_property_to_text_list ##### -->
<para>
-Convert a text string from the encoding as it is stored in
+Converts a text string from the encoding as it is stored in
a property into an array of strings in the encoding of
the current local. (The elements of the array represent
-the null-separated elements of the original text string.)
+the nul-separated elements of the original text string.)
</para>
@encoding: an atom representing the encoding. The most common
value used as the type for the property.
@format: the format of the property.
@text: the text data.
-@length: the length of the property, in item.s
+@length: the length of the property, in items.
@list: location to store a terminated array of strings
in the encoding of the current locale. This
array should be freed using gdk_free_text_list().
<!-- ##### FUNCTION gdk_free_text_list ##### -->
<para>
-Free the array of strings created by
+Frees the array of strings created by
gdk_text_property_to_text_list().
</para>
<!-- ##### FUNCTION gdk_string_to_compound_text ##### -->
<para>
-Convert a string from the encoding of the current locale
+Converts a string from the encoding of the current locale
into a form suitable for storing in a window property.
</para>
-@str: a null-terminated string.
+@str: a nul-terminated string.
@encoding: location to store the encoding atom (to be used as the type for the property).
@format: location to store the format for the property.
@ctext: location to store newly allocated data for the property.
<!-- ##### FUNCTION gdk_free_compound_text ##### -->
<para>
-Free the data returned from gdk_string_to_compound_text().
+Frees the data returned from gdk_string_to_compound_text().
</para>
@ctext: The pointer stored in @ctext from a call to gdk_string_to_compound_text().
<!-- ##### FUNCTION gdk_atom_intern ##### -->
<para>
-Find or create an atom corresponding to a given string.
+Finds or creates an atom corresponding to a given string.
</para>
@atom_name: a string.
@only_if_exists: if %TRUE, do not create a new atom, but
just return the atom if it already exists.
@Returns: the atom corresponding to @atom_name, or, if
- @only_if_exists is TRUE, and an atom does not
+ @only_if_exists is %TRUE, and an atom does not
already exists for the string, %GDK_NONE.
<!-- ##### FUNCTION gdk_atom_name ##### -->
<para>
-Determine the string corresponding to an atom.
+Determines the string corresponding to an atom.
</para>
@atom: a #GdkAtom.
-@Returns: a newly allocated string containing the string
+@Returns: a newly-allocated string containing the string
corresponding to @atom. When you are done
with the return value, you should free it
using g_free().
<!-- ##### FUNCTION gdk_property_get ##### -->
<para>
Retrieves a portion of the contents of a property. If the
-property does not exist, then the function returns FALSE,
+property does not exist, then the function returns %FALSE,
and %GDK_NONE will be stored in @actual_property_type.
-
-Note: the <function>XGetWindowProperty()</function>
+</para>
+<note>
+<para>
+The <function>XGetWindowProperty()</function>
function that gdk_property_get()
uses has a very confusing and complicated set of semantics.
Unfortunately, gdk_property_get() makes the situation
directly until a replacement function for gdk_property_get()
is provided.
</para>
+</note>
@window: a #GdkWindow.
@property: the property to retrieve.
<!-- ##### FUNCTION gdk_property_change ##### -->
<para>
-Change the contents of a property on a window.
+Changes the contents of a property on a window.
</para>
@window: a #GdkWindow.
<!-- ##### FUNCTION gdk_property_delete ##### -->
<para>
-Delete a property from a window.
+Deletes a property from a window.
</para>
@window: a #GdkWindow.
<!-- ##### MACRO GDK_SELECTION_PRIMARY ##### -->
<para>
-
+A #GdkAtom representing the <literal>PRIMARY</literal> selection.
</para>
<!-- ##### MACRO GDK_SELECTION_SECONDARY ##### -->
<para>
-
+A #GdkAtom representing the <literal>SECONDARY</literal> selection.
</para>
<!-- ##### MACRO GDK_SELECTION_CLIPBOARD ##### -->
<para>
-
+A #GdkAtom representing the <literal>CLIPBOARD</literal> selection.
</para>
<!-- ##### MACRO GDK_TARGET_BITMAP ##### -->
<para>
-
+A #GdkAtom representing the <literal>BITMAP</literal> selection target.
</para>
<!-- ##### MACRO GDK_TARGET_COLORMAP ##### -->
<para>
-
+A #GdkAtom representing the <literal>COLORMAP</literal> selection target.
</para>
<!-- ##### MACRO GDK_TARGET_DRAWABLE ##### -->
<para>
-
+A #GdkAtom representing the <literal>DRAWABLE</literal> selection target.
</para>
<!-- ##### MACRO GDK_TARGET_PIXMAP ##### -->
<para>
-
+A #GdkAtom representing the <literal>PIXMAP</literal> selection target.
</para>
<!-- ##### MACRO GDK_TARGET_STRING ##### -->
<para>
-
+A #GdkAtom representing the <literal>STRING</literal> selection target.
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_ATOM ##### -->
<para>
-
+A #GdkAtom representing the <literal>ATOM</literal> selection type.
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_BITMAP ##### -->
<para>
-
+A #GdkAtom representing the <literal>BITMAP</literal> selection type.
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_COLORMAP ##### -->
<para>
-
+A #GdkAtom representing the <literal>COLORMAP</literal> selection type.
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_DRAWABLE ##### -->
<para>
-
+A #GdkAtom representing the <literal>DRAWABLE</literal> selection type.
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_INTEGER ##### -->
<para>
-
+A #GdkAtom representing the <literal>INTEGER</literal> selection type.
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_PIXMAP ##### -->
<para>
-
+A #GdkAtom representing the <literal>PIXMAP</literal> selection type.
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_WINDOW ##### -->
<para>
-
+A #GdkAtom representing the <literal>WINDOW</literal> selection type.
</para>
<!-- ##### MACRO GDK_SELECTION_TYPE_STRING ##### -->
<para>
-
+A #GdkAtom representing the <literal>STRING</literal> selection type.
</para>
<!-- ##### FUNCTION gdk_selection_owner_set ##### -->
<para>
-Set the owner of the given selection.
+Sets the owner of the given selection.
</para>
-@owner: a #GdkWindow or NULL to indicate that the
+@owner: a #GdkWindow or %NULL to indicate that the
the owner for the given should be unset.
@selection: an atom identifying a selection.
@time: timestamp to use when setting the selection.
<!-- ##### FUNCTION gdk_selection_owner_get ##### -->
<para>
-Determine the owner of the given selection.
+Determines the owner of the given selection.
</para>
@selection: an atom indentifying a selection.
@Returns: if there is a selection owner for this window,
and it is a window known to the current process,
the #GdkWindow that owns the selection, otherwise
- NULL. Note that the return value may be owned
+ %NULL. Note that the return value may be owned
by a different process if a foreign window
was previously created for that window, but
a new foreign window will never be created by
<!-- ##### FUNCTION gdk_selection_convert ##### -->
<para>
-Retrieve the contents of a selection in a given
+Retrieves the contents of a selection in a given
form.
</para>
<!-- ##### FUNCTION gdk_selection_property_get ##### -->
<para>
-Retrieve selection data that was stored by the selection
-data in response to a call to gdk_selection_convert()
+Retrieves selection data that was stored by the selection
+data in response to a call to gdk_selection_convert().
</para>
@requestor: the window on which the data is stored
@data: location to store a pointer to the retrieved data.
- If the retrieval failed, NULL we be stored here, otherwise, it
- will be non-NULL and the returned data should be freed with g_free()
+ If the retrieval failed, %NULL we be stored here, otherwise, it
+ will be non-%NULL and the returned data should be freed with g_free()
when you are finished using it. The length of the
allocated memory is one more than the the length
of the returned data, and the final byte will always
- be zero, to ensure null-termination of strings.
+ be zero, to ensure nul-termination of strings.
@prop_type: location to store the type of the property.
@prop_format: location to store the format of the property.
@Returns: the length of the retrieved data.
<!-- ##### FUNCTION gdk_selection_send_notify ##### -->
<para>
-Send a response to SelectionRequest event.
+Sends a response to SelectionRequest event.
</para>
@requestor: window to which to deliver response.
* gdk_x11_atom_to_xatom:
* @atom: A #GdkAtom
*
- * Convert from a #GdkAtom to the X atom for the default GDK display
- * with the same string value.x
+ * Converts from a #GdkAtom to the X atom for the default GDK display
+ * with the same string value.
*
* Return value: the X atom corresponding to @atom.
**/
* gdk_x11_xatom_to_atom:
* @xatom: an X atom for the default GDK display
*
- * Convert from an X atom for the default display to the corresponding
+ * Converts from an X atom for the default display to the corresponding
* #GdkAtom.
*
- * Return value: the corresponding G#dkAtom.
+ * Return value: the corresponding #GdkAtom.
**/
GdkAtom
gdk_x11_xatom_to_atom (Atom xatom)
*
* Returns the X atom for GDK's default display corresponding to @atom_name.
* This function caches the result, so if called repeatedly it is much
- * faster than XInternAtom, which is a round trip to the server each time.
+ * faster than <function>XInternAtom()</function>, which is a round trip to
+ * the server each time.
*
* Return value: a X atom for GDK's default display.
**/
*
* Returns the name of an X atom for GDK's default display. This
* function is meant mainly for debugging, so for convenience, unlike
- * XAtomName() and gdk_atom_name(), the result doesn't need to
- * be freed. Also, this function will never return %NULL, even
- * if @xatom is invalid.
+ * <function>XAtomName()</function> and gdk_atom_name(), the result
+ * doesn't need to be freed. Also, this function will never return %NULL,
+ * even if @xatom is invalid.
*
* Return value: name of the X atom; this string is owned by GTK+,
* so it shouldn't be modifed or freed.
* @list: location to store the list of strings or %NULL. The
* list should be freed with g_strfreev().
*
- * Convert a text property in the giving encoding to
+ * Converts a text property in the giving encoding to
* a list of UTF-8 strings.
*
* Return value: the number of strings in the resulting
* gdk_utf8_to_string_target:
* @str: a UTF-8 string
*
- * Convert an UTF-8 string into the best possible representation
+ * Converts an UTF-8 string into the best possible representation
* as a STRING. The representation of characters not in STRING
* is not specified; it may be as pseudo-escape sequences
* \x{ABCD}, or it may be in some other form of approximation.
*
- * Return value: the newly allocated string, or %NULL if the
+ * Return value: the newly-allocated string, or %NULL if the
* conversion failed. (It should not fail for
* any properly formed UTF-8 string.)
**/
* @length: location to store the length of the data
* stored in @ctext
*
- * Convert from UTF-8 to compound text.
+ * Converts from UTF-8 to compound text.
*
* Return value: %TRUE if the conversion succeeded, otherwise
- * false.
+ * %FALSE.
**/
gboolean
gdk_utf8_to_compound_text (const gchar *str,
projects / gtk4.git / commitdiff